home *** CD-ROM | disk | FTP | other *** search
/ Aminet 40 / Aminet 40 (2000)(Schatztruhe)[!][Dec 2000].iso / Aminet / dev / gui / MR_Classes.lha / MR_Classes / Dev / AutoDocs / palette_req.doc next >
Encoding:
Text File  |  2000-09-05  |  3.6 KB  |  136 lines
  1. TABLE OF CONTENTS
  2.  
  3. palette.requester/--datasheet--
  4. palette.requester/--history--
  5. palette.requester/PREQ_DisposeRequester
  6. palette.requester/PREQ_NewRequester
  7. palette.requester/--datasheet--               palette.requester/--datasheet--
  8.  
  9.    NAME
  10.        palette.requester -- Requester for editing a color palette
  11.  
  12.    REQUIRES
  13.        supermodel.class
  14.        tcpalette.gadget
  15.        Reaction gadgets
  16.  
  17.    METHODS
  18.        OM_NEW - creatres new requester object.
  19.          Only available through PREQ_NewRequester()
  20.  
  21.        OM_DISPOSE - dispose requester.
  22.          Only available through PREQ_DisposeRequester()
  23.  
  24.        OM_SET -
  25.  
  26.        OM_GET - 
  27.  
  28.        RM_DOREQUEST - open requester
  29.  
  30.        RM_DOREQUESTASYNC - unimplemented
  31.  
  32.    ATTRIBUTES
  33.        PR_Screen - Screen to open requester on.
  34.        (OM_NEW, OM_SET)
  35.        
  36.        PR_Window - Parent Window
  37.        (OM_NEW, OM_SET)
  38.  
  39.        PR_PubScreenName - Public Screen Name
  40.        (OM_NEW, OM_SET)
  41.  
  42.        PR_Colors - Number of colors to edit 1..256
  43.        (OM_NEW, OM_SET)
  44.  
  45.        PR_Palette - Palette to edit, must be at least 
  46.          PR_Colors entries in the array of struct prRGB.
  47.          When you get this attribute, you must supply a buffer
  48.          with enough memory to hold and PR_Colors size array of 
  49.          struct prRGB
  50.        (OM_NEW, OM_SET, OM_GET)
  51.  
  52.        PR_TextAttr - TextAttr of gadget Text.
  53.        (OM_SET)
  54.  
  55.        PR_TitleText - Text of window
  56.        (OM_NEW, OM_SET)
  57.  
  58.        PR_PositiveText - "Ok"
  59.        (OM_NEW, OM_SET)
  60.  
  61.        PR_NegativeText - "Cancel"
  62.        (OM_NEW, OM_SET)
  63.  
  64.        PR_InitialTopEdge,LeftEdge,Width,Height - Initial values for window. 
  65.          not implemented.
  66.        (OM_NEW, OM_SET)
  67.  
  68.        PR_Red/Green/BlueBits - Bits per component. not implemented. 
  69.  
  70.    RESULT
  71.  
  72.    EXAMPLE
  73.  
  74.    NOTES
  75.        While this requester keeps 32bit per component (RGB), due to limitatio
  76. ns
  77.        of the slider gadget, edits only 8bits per component, only 256 levels.
  78.   
  79.        Future versions may fix this.
  80.  
  81.    BUGS
  82.        Bad things will happen if you OM_GET PR_Palette with an array that 
  83.        doesn't have atleast PR_Colors entries.
  84.  
  85.        The Undo gadget won't disable on the first pen edited.
  86.  
  87.    SEE ALSO
  88.  
  89. palette.requester/--history--                   palette.requester/--history--
  90.  
  91.    To Do -
  92.        * Maybe cause requester to notify other object WHILE open?
  93.        * Menu's to load/save, and a "Preset" menu
  94.        * Create pop-up gadget class (similar to GetScreenMode etc.)
  95.  
  96.    44.1 - 
  97.        * OM_GET wasn't handled in the dispatcher.
  98.        * Getting PR_Palette now works - requester was kinda useless before.
  99.        * Setting PR_Screen, Window, PubScreenName will center the requester
  100.    44.2 - 
  101.        * Included version string
  102.    44.3 -
  103.        * All source files needed to be recompiled for 44.2, but were not.
  104.        * If you cancel the gadget, and then OM_GET PR_Palette, you will get
  105.          a copy of the initial palette
  106.  
  107. palette.requester/PREQ_DisposeRequesteralette.requester/PREQ_DisposeRequester
  108.  
  109.    NAME
  110.        PREQ_DisposeRequester -- Dispose palette requester.
  111.  
  112. palette.requester/PREQ_NewRequester       palette.requester/PREQ_NewRequester
  113.  
  114.    NAME
  115.        PREQ_NewRequester -- Allocate a new Palette requester.
  116.  
  117.    SYNOPSIS
  118.        Object = PREQ_NewRequester(Tags,...)
  119.  
  120.        Object *PREQ_NewRequester(Tag, ...);
  121.        a0                        a0
  122.  
  123.        Object *PREQ_NewRequesterA(struct TagItem *)
  124.        a0                                a0
  125.  
  126.    FUNCTION
  127.        Allocates a new Palette requester object.
  128.        The palette requester is a BOOPSI object.
  129.        Further settings can be changed or read
  130.        with SetAttrs() or GetAttr().
  131.  
  132.  
  133.    SEE ALSO
  134.        palette.requester/--datasheet--
  135.  
  136.